Cisco-IOS-XR-ip-rib-ipv6-oper API API Reference
API generated from Cisco-IOS-XR-ip-rib-ipv6-oper@2017-09-07.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/{{node-name}}/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
IPV6-RIB - Retrieve
Retrieve operation of resource: ipv6-rib
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string"
}
]
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
RIB-TABLE-IDS - Retrieve
Retrieve operation of resource: rib-table-ids
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-table-id": [
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
}
]
}
}
]
}
RIB-TABLE-ID - Retrieve
Retrieve operation of resource: rib-table-id
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
}
SUMMARY-PROTOS - Retrieve
Retrieve operation of resource: summary-protos
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-sum": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-none": {
"num-active-paths": "integer"
}
}
]
}
SUMMARY-PROTO - Retrieve
Retrieve operation of resource: summary-proto
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-sum": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-none": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
}
PROTO-ROUTE-COUNT - Retrieve
Retrieve operation of resource: proto-route-count
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-NONE - Retrieve
Retrieve operation of resource: rtype-none
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OTHER - Retrieve
Retrieve operation of resource: rtype-other
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-INTRA - Retrieve
Retrieve operation of resource: rtype-ospf-intra
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-INTER - Retrieve
Retrieve operation of resource: rtype-ospf-inter
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-EXTERN1 - Retrieve
Retrieve operation of resource: rtype-ospf-extern1
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-EXTERN2 - Retrieve
Retrieve operation of resource: rtype-ospf-extern2
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-SUM - Retrieve
Retrieve operation of resource: rtype-isis-sum
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-L1 - Retrieve
Retrieve operation of resource: rtype-isis-l1
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-L2 - Retrieve
Retrieve operation of resource: rtype-isis-l2
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-L1-IA - Retrieve
Retrieve operation of resource: rtype-isis-l1-ia
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-BGP-INT - Retrieve
Retrieve operation of resource: rtype-bgp-int
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-BGP-EXT - Retrieve
Retrieve operation of resource: rtype-bgp-ext
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-BGP-LOC - Retrieve
Retrieve operation of resource: rtype-bgp-loc
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-NSSA1 - Retrieve
Retrieve operation of resource: rtype-ospf-nssa1
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-NSSA2 - Retrieve
Retrieve operation of resource: rtype-ospf-nssa2
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-IGRP2-INT - Retrieve
Retrieve operation of resource: rtype-igrp2-int
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-IGRP2-EXT - Retrieve
Retrieve operation of resource: rtype-igrp2-ext
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RIB-TABLE-ITF-HNDLS - Retrieve
Retrieve operation of resource: rib-table-itf-hndls
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-table-itf-hndl": [
{
"itf-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
]
}
RIB-TABLE-ITF-HNDL - Retrieve
Retrieve operation of resource: rib-table-itf-hndl
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"itf-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
ITF-ROUTE - Retrieve
Retrieve operation of resource: itf-route
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
]
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
AFS - Retrieve
Retrieve operation of resource: afs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer"
}
]
}
}
]
}
}
]
}
}
]
}
}
SAFS - Retrieve
Retrieve operation of resource: safs
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean"
}
]
}
}
]
}
}
]
}
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string"
}
]
}
}
]
}
}
]
}
}
IP-RIB-ROUTE-TABLE-NAMES - Retrieve
Retrieve operation of resource: ip-rib-route-table-names
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean"
}
]
}
}
]
}
}
]
}
IP-RIB-ROUTE-TABLE-NAME - Retrieve
Retrieve operation of resource: ip-rib-route-table-name
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer"
}
]
}
}
]
}
}
DESTINATION-KW - Retrieve
Retrieve operation of resource: destination-kw
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-backup-routes": {
"dest-backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer"
}
]
}
}
]
}
}
DEST-Q-ROUTES - Retrieve
Retrieve operation of resource: dest-q-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-Q-ROUTE - Retrieve
Retrieve operation of resource: dest-q-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
DEST-BACKUP-ROUTES - Retrieve
Retrieve operation of resource: dest-backup-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-BACKUP-ROUTE - Retrieve
Retrieve operation of resource: dest-backup-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
DEST-BEST-ROUTES - Retrieve
Retrieve operation of resource: dest-best-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-best-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-BEST-ROUTE - Retrieve
Retrieve operation of resource: dest-best-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
DEST-NEXT-HOP-ROUTES - Retrieve
Retrieve operation of resource: dest-next-hop-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-next-hop-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-NEXT-HOP-ROUTE - Retrieve
Retrieve operation of resource: dest-next-hop-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
ADVERTS - Retrieve
Retrieve operation of resource: adverts
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"advert": [
{
"ipv6-rib-edm-advert": [
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
]
}
]
}
ADVERT - Retrieve
Retrieve operation of resource: advert
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-advert": [
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
]
}
IPV6-RIB-EDM-ADVERT - Retrieve
Retrieve operation of resource: ipv6-rib-edm-advert
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
DELETED-ROUTES - Retrieve
Retrieve operation of resource: deleted-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"deleted-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DELETED-ROUTE - Retrieve
Retrieve operation of resource: deleted-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
PROTOCOL - Retrieve
Retrieve operation of resource: protocol
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"subscriber": {
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
}
}
LOCAL - Retrieve
Retrieve operation of resource: local
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
LSPV - Retrieve
Retrieve operation of resource: lspv
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
BGP - Retrieve
Retrieve operation of resource: bgp
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
MOBILE - Retrieve
Retrieve operation of resource: mobile
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
EIGRP - Retrieve
Retrieve operation of resource: eigrp
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
RPL - Retrieve
Retrieve operation of resource: rpl
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
STATIC - Retrieve
Retrieve operation of resource: static
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
TE-CLIENT - Retrieve
Retrieve operation of resource: te-client
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
SUBSCRIBER - Retrieve
Retrieve operation of resource: subscriber
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
OSPF - Retrieve
Retrieve operation of resource: ospf
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
CONNECTED - Retrieve
Retrieve operation of resource: connected
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
L2VPN - Retrieve
Retrieve operation of resource: l2vpn
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
ISIS - Retrieve
Retrieve operation of resource: isis
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
ROUTES - Retrieve
Retrieve operation of resource: routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
ROUTE - Retrieve
Retrieve operation of resource: route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
Q-ROUTES - Retrieve
Retrieve operation of resource: q-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
Q-ROUTE - Retrieve
Retrieve operation of resource: q-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
BACKUP-ROUTES - Retrieve
Retrieve operation of resource: backup-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
BACKUP-ROUTE - Retrieve
Retrieve operation of resource: backup-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
IPV6-RIB-STDBY - Retrieve
Retrieve operation of resource: ipv6-rib-stdby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string"
}
]
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
RIB-TABLE-IDS - Retrieve
Retrieve operation of resource: rib-table-ids
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-table-id": [
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
}
]
}
}
]
}
RIB-TABLE-ID - Retrieve
Retrieve operation of resource: rib-table-id
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
}
SUMMARY-PROTOS - Retrieve
Retrieve operation of resource: summary-protos
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-sum": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-none": {
"num-active-paths": "integer"
}
}
]
}
SUMMARY-PROTO - Retrieve
Retrieve operation of resource: summary-proto
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-sum": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-none": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
}
PROTO-ROUTE-COUNT - Retrieve
Retrieve operation of resource: proto-route-count
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-NONE - Retrieve
Retrieve operation of resource: rtype-none
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OTHER - Retrieve
Retrieve operation of resource: rtype-other
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-INTRA - Retrieve
Retrieve operation of resource: rtype-ospf-intra
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-INTER - Retrieve
Retrieve operation of resource: rtype-ospf-inter
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-EXTERN1 - Retrieve
Retrieve operation of resource: rtype-ospf-extern1
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-EXTERN2 - Retrieve
Retrieve operation of resource: rtype-ospf-extern2
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-SUM - Retrieve
Retrieve operation of resource: rtype-isis-sum
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-L1 - Retrieve
Retrieve operation of resource: rtype-isis-l1
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-L2 - Retrieve
Retrieve operation of resource: rtype-isis-l2
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-ISIS-L1-IA - Retrieve
Retrieve operation of resource: rtype-isis-l1-ia
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-BGP-INT - Retrieve
Retrieve operation of resource: rtype-bgp-int
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-BGP-EXT - Retrieve
Retrieve operation of resource: rtype-bgp-ext
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-BGP-LOC - Retrieve
Retrieve operation of resource: rtype-bgp-loc
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-NSSA1 - Retrieve
Retrieve operation of resource: rtype-ospf-nssa1
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-OSPF-NSSA2 - Retrieve
Retrieve operation of resource: rtype-ospf-nssa2
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-IGRP2-INT - Retrieve
Retrieve operation of resource: rtype-igrp2-int
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RTYPE-IGRP2-EXT - Retrieve
Retrieve operation of resource: rtype-igrp2-ext
tableid
in path
string
ID of tableid
protoid
in path
string
ID of protoid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
RIB-TABLE-ITF-HNDLS - Retrieve
Retrieve operation of resource: rib-table-itf-hndls
tableid
in path
string
ID of tableid
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rib-table-itf-hndl": [
{
"itf-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
]
}
RIB-TABLE-ITF-HNDL - Retrieve
Retrieve operation of resource: rib-table-itf-hndl
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"itf-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
ITF-ROUTE - Retrieve
Retrieve operation of resource: itf-route
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
tableid
in path
string
ID of tableid
handle
in path
string
ID of handle
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
]
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
AFS - Retrieve
Retrieve operation of resource: afs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
AF - Retrieve
Retrieve operation of resource: af
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer"
}
]
}
}
]
}
}
]
}
}
]
}
}
SAFS - Retrieve
Retrieve operation of resource: safs
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean"
}
]
}
}
]
}
}
]
}
}
]
}
SAF - Retrieve
Retrieve operation of resource: saf
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string"
}
]
}
}
]
}
}
]
}
}
IP-RIB-ROUTE-TABLE-NAMES - Retrieve
Retrieve operation of resource: ip-rib-route-table-names
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean"
}
]
}
}
]
}
}
]
}
IP-RIB-ROUTE-TABLE-NAME - Retrieve
Retrieve operation of resource: ip-rib-route-table-name
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer"
}
]
}
}
]
}
}
DESTINATION-KW - Retrieve
Retrieve operation of resource: destination-kw
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-backup-routes": {
"dest-backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer"
}
]
}
}
]
}
}
DEST-Q-ROUTES - Retrieve
Retrieve operation of resource: dest-q-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-Q-ROUTE - Retrieve
Retrieve operation of resource: dest-q-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
DEST-BACKUP-ROUTES - Retrieve
Retrieve operation of resource: dest-backup-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-BACKUP-ROUTE - Retrieve
Retrieve operation of resource: dest-backup-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
DEST-BEST-ROUTES - Retrieve
Retrieve operation of resource: dest-best-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-best-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-BEST-ROUTE - Retrieve
Retrieve operation of resource: dest-best-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
DEST-NEXT-HOP-ROUTES - Retrieve
Retrieve operation of resource: dest-next-hop-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dest-next-hop-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DEST-NEXT-HOP-ROUTE - Retrieve
Retrieve operation of resource: dest-next-hop-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
address
in path
string
ID of address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
ADVERTS - Retrieve
Retrieve operation of resource: adverts
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"advert": [
{
"ipv6-rib-edm-advert": [
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
]
}
]
}
ADVERT - Retrieve
Retrieve operation of resource: advert
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-advert": [
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
]
}
IPV6-RIB-EDM-ADVERT - Retrieve
Retrieve operation of resource: ipv6-rib-edm-advert
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
DELETED-ROUTES - Retrieve
Retrieve operation of resource: deleted-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"deleted-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
DELETED-ROUTE - Retrieve
Retrieve operation of resource: deleted-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
PROTOCOL - Retrieve
Retrieve operation of resource: protocol
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"subscriber": {
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
}
}
LOCAL - Retrieve
Retrieve operation of resource: local
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
LSPV - Retrieve
Retrieve operation of resource: lspv
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
BGP - Retrieve
Retrieve operation of resource: bgp
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
MOBILE - Retrieve
Retrieve operation of resource: mobile
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
EIGRP - Retrieve
Retrieve operation of resource: eigrp
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
RPL - Retrieve
Retrieve operation of resource: rpl
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
STATIC - Retrieve
Retrieve operation of resource: static
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
TE-CLIENT - Retrieve
Retrieve operation of resource: te-client
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
SUBSCRIBER - Retrieve
Retrieve operation of resource: subscriber
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
OSPF - Retrieve
Retrieve operation of resource: ospf
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
CONNECTED - Retrieve
Retrieve operation of resource: connected
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
}
L2VPN - Retrieve
Retrieve operation of resource: l2vpn
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
NON-AS - Retrieve
Retrieve operation of resource: non-as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
ISIS - Retrieve
Retrieve operation of resource: isis
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
AS - Retrieve
Retrieve operation of resource: as
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
INFORMATION - Retrieve
Retrieve operation of resource: information
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTES - Retrieve
Retrieve operation of resource: protocol-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
PROTOCOL-ROUTE - Retrieve
Retrieve operation of resource: protocol-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
as
in path
string
ID of as
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
ROUTES - Retrieve
Retrieve operation of resource: routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
ROUTE - Retrieve
Retrieve operation of resource: route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
Q-ROUTES - Retrieve
Retrieve operation of resource: q-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
Q-ROUTE - Retrieve
Retrieve operation of resource: q-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
BACKUP-ROUTES - Retrieve
Retrieve operation of resource: backup-routes
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
BACKUP-ROUTE - Retrieve
Retrieve operation of resource: backup-route
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string"
}
]
}
}
ROUTE-PATH - Retrieve
Retrieve operation of resource: route-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PATH - Retrieve
Retrieve operation of resource: ipv6-rib-edm-path
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
REMOTE-BACKUP-ADDR - Retrieve
Retrieve operation of resource: remote-backup-addr
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LABELSTK - Retrieve
Retrieve operation of resource: labelstk
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
NEXT-NEXT-HOP - Retrieve
Retrieve operation of resource: next-next-hop
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
SRV6SID - Retrieve
Retrieve operation of resource: srv6sid
vrf-name
in path
string
ID of vrf-name
af-name
in path
string
ID of af-name
saf-name
in path
string
ID of saf-name
route-table-name
in path
string
ID of route-table-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sid": "string"
}
Schema Definitions
RIB-EDM-NNH:
Information of a NNH in path installed in RIB
- unknownval: integer
-
Unknown Value
- type: string unknown, ipv4-address, if-index
-
type
- interface-index: integer
-
Interface Index
- address: string
-
IPv4 Address
Example
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
INFORMATION:
Common node of as, non-as, l2vpn, lspv
- information: IPV6-RIB-EDM-PROTO
-
Protocol related Information
Example
{
"information": {
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
}
VRF-TABLE:
Common node of ipv6-rib, ipv6-rib-stdby
- vrfs: object
-
VRF table
Example
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
RIB-TABLE:
Common node of ipv6-rib, ipv6-rib-stdby
- rib-table-ids: object
-
RIB table
Example
{
"rib-table-ids": {
"rib-table-id": [
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer"
}
}
]
}
}
]
}
}
RIB-EDM-PROTO-ROUTE-SUMM-DETAIL:
Details of Protocol route types
- rtype-other: RIB-EDM-ROUTE-COUNT
-
Unknown route type
- rtype-ospf-intra: RIB-EDM-ROUTE-COUNT
-
OSPF route within an area
- rtype-bgp-int: RIB-EDM-ROUTE-COUNT
-
iBGP route
- rtype-isis-l1: RIB-EDM-ROUTE-COUNT
-
IS-IS level 1 route
- proto-route-count: RIB-EDM-ROUTE-COUNT
-
Count for proto. instance
- rtype-ospf-inter: RIB-EDM-ROUTE-COUNT
-
OSPF route across diff. areas
- rtype-isis-l2: RIB-EDM-ROUTE-COUNT
-
IS-IS level 2 route
- rtype-igrp2-ext: RIB-EDM-ROUTE-COUNT
-
EIGRP external route
- instance: string
-
Instance
- rtype-bgp-ext: RIB-EDM-ROUTE-COUNT
-
eBGP route
- rtype-bgp-loc: RIB-EDM-ROUTE-COUNT
-
BGP local route
- name: string
-
Proto name
- rtype-isis-l1-ia: RIB-EDM-ROUTE-COUNT
-
IS-IS level1 inter-area route
- rtype-ospf-extern1: RIB-EDM-ROUTE-COUNT
-
OSPF external route of type 1
- rtype-ospf-extern2: RIB-EDM-ROUTE-COUNT
-
OSPF external route of type 2
- rtype-isis-sum: RIB-EDM-ROUTE-COUNT
-
IS-IS summary route
- rtype-igrp2-int: RIB-EDM-ROUTE-COUNT
-
EIGRP internal route
- rtype-none: RIB-EDM-ROUTE-COUNT
-
No route type
- rtype-ospf-nssa1: RIB-EDM-ROUTE-COUNT
-
OSPF NSSA ext. route type 1
- rtype-ospf-nssa2: RIB-EDM-ROUTE-COUNT
-
OSPF NSSA ext. route type 2
Example
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-sum": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-none": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
}
IPV6-RIB-EDM-PATH:
Information of a rib path
- ipv6-rib-edm-path: object[]
-
ipv6 rib edm path
Example
{
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
IPV6-RIB-EDM-PROTO:
Information of a rib protocol
- backup-routes-count: integer
-
Number of backup routes
- protocol-clients-count: integer
-
Number of proto clients
- paths-count: integer
-
Number of paths for all routes
- protocol-route-memory: integer
-
Memory for proto's routes and paths in bytes
- instance: string
-
Instance
- version: integer
-
Proto version
- redistribution-client-count: integer
-
Number of redist clients
- deleted-routes-count: integer
-
Number of deleted routes
- routes-counts: integer
-
Number of routes (including active, backup and deleted), where, number of backup routes = RoutesCounts - ActiveRoutesCount - DeletedRoutesCount
- active-routes-count: integer
-
Number of active routes (not deleted)
- protocol-names: string
-
Name
Example
{
"backup-routes-count": "integer",
"protocol-clients-count": "integer",
"paths-count": "integer",
"protocol-route-memory": "integer",
"instance": "string",
"version": "integer",
"redistribution-client-count": "integer",
"deleted-routes-count": "integer",
"routes-counts": "integer",
"active-routes-count": "integer",
"protocol-names": "string"
}
PROTOCOL-ROUTE-TABLE:
Common node of as, non-as, l2vpn, lspv
- protocol-routes: object
-
Protocol specific Route
Example
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer"
}
]
}
}
]
}
}
RIB-EDM-ROUTE-COUNT:
Specifics of route count
- num-active-paths: integer
-
Number of paths to active routes
- num-backup-paths: integer
-
Number of paths to backup routes
- active-routes-count: integer
-
Number of active routes
- num-backup-routes: integer
-
Number of backup (inactive) routes
Example
{
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
AS:
Common node of bgp, ospf, isis, eigrp, rpl
- as: object[]
-
Autonomous System of protocol
Example
{
"as": [
{
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string"
}
]
}
}
]
}
}
]
}
NON-AS:
Common node of local, connected, static, subscriber, mobile, te-client
- non-as: PROTOCOL-ROUTE-TABLE
-
Non Autonomous System of protocol
Example
{
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean"
}
]
}
}
]
}
}
}
RIB-EDM-SRV6-SID:
Information of SRv6 SID attribute installed in the RIB
- sid: string
-
Segment Identifier Attribute
Example
{
"sid": "string"
}
IPV6-RIB-EDM-TABLE:
Information of a routing table
- num-svdrem-prefix: integer
-
Num SVD remote prefixes
- fwd-referenced: boolean
-
Table in fwd reference state?
- afi: integer
-
Address Family
- safi: integer
-
sub Address Family
- deleted: boolean
-
Table deleted?
- prefix-limit-notified: boolean
-
Prefix limit state indicator
- table-version: integer
-
Version no. of the table
- vrf-name: string
-
VRF Name of the table
- version: integer
-
Table version
- tableid: integer
-
Table id
- initial-converge: boolean
-
Table has reached convergence
- conf-prefix-limit: integer
-
Configured prefix limit
- num-svdlcl-prefix: integer
-
Num SVD local prefixes
- table-name: string
-
Name of the table
- current-prefix-count: integer
-
Num prefixes in table
Example
{
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
}
IPV6-RIB-EDM-ADVERT:
Route advertisement information
- ipv6-rib-edm-advert: object[]
-
ipv6 rib edm advert
Example
{
"ipv6-rib-edm-advert": [
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
]
}
IPV6-RIB-EDM-ROUTE:
Information of a rib route head and rib proto route
- client-id: integer
-
Client adding the route to RIB
- attribute-identity: integer
-
BGP Attribute ID
- metric: integer
-
Route metric
- prefix-length-xr: integer
-
Length of prefix
- svd-type: integer
-
SVD Type of route
- prefix: string
-
Route prefix
- extended-flags: integer
-
Extended Route flags
- traffic-index: integer
-
BGP Traffic Index
- diversion-proto-name: string
-
Diversion route protocol name
- diversion-distance: integer
-
Diversion distance of the route
- protocol-name: string
-
Name of Protocol
- priority: integer
-
Route priority
- instance: string
-
Instance name
- version: integer
-
Route Version
- has-s-rv6-func: boolean
-
Route has some SRv6 func associated
- route-precedence: integer
-
Route ip precedence
- route-label: integer
-
Local label of the route
- route-modify-time: integer
-
Route modification time(nanoseconds)
- paths-count: integer
-
Number of paths
- qos-group: integer
-
Route qos group
- route-type: integer
-
Route type
- active: boolean
-
Is the route active or backup
- route-version: integer
-
Route version
- route-age: integer
-
Age of route (seconds)
- fwd-class: integer
-
Forward Class
- distance: integer
-
Distance of the route
- diversion: boolean
-
Route has a diversion path
- flow-tag: integer
-
Flow tag
- tag: integer
-
Opaque proto specific info
- flags: integer
-
Route flags
- route-path: IPV6-RIB-EDM-PATH
-
Path(s) of the route
- protocol-id: integer
-
Protocol advertising the route
- pic-count: integer
-
Number of pic paths in this route
- srv6-func-str: string
-
String representation of SRv6 func
- tbl-version: integer
-
Table Version
Example
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
]
}
}
rib-table-ids_schema:
RIB table
- rib-table-id: object[]
-
Specific Table
Example
{
"rib-table-id": [
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
}
}
]
}
}
]
}
rib-table-id_schema:
- information: IPV6-RIB-EDM-TABLE
-
Table related Information
- tableid: string
-
Table ID
- summary-protos: object
-
RIB table summary
- rib-table-itf-hndls: object
-
RIB table interface
Example
{
"information": {
"num-svdrem-prefix": "integer",
"fwd-referenced": "boolean",
"afi": "integer",
"safi": "integer",
"deleted": "boolean",
"prefix-limit-notified": "boolean",
"table-version": "integer",
"vrf-name": "string",
"version": "integer",
"tableid": "integer",
"initial-converge": "boolean",
"conf-prefix-limit": "integer",
"num-svdlcl-prefix": "integer",
"table-name": "string",
"current-prefix-count": "integer"
},
"tableid": "string",
"summary-protos": {
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer"
}
}
]
}
}
summary-protos_schema:
RIB table summary
- summary-proto: RIB-EDM-PROTO-ROUTE-SUMM-DETAIL
-
Route summary information for a specific table/protocol
Example
{
"summary-proto": [
{
"rtype-other": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-intra": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"proto-route-count": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-inter": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-l2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"instance": "string",
"rtype-bgp-ext": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-bgp-loc": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"name": "string",
"rtype-isis-l1-ia": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern1": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-ospf-extern2": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-isis-sum": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-igrp2-int": {
"num-active-paths": "integer",
"num-backup-paths": "integer",
"active-routes-count": "integer",
"num-backup-routes": "integer"
},
"rtype-none": {
"num-active-paths": "integer",
"num-backup-paths": "integer"
}
}
]
}
rib-table-itf-hndls_schema:
RIB table interface
- rib-table-itf-hndl: object[]
-
Interface handle
Example
{
"rib-table-itf-hndl": [
{
"itf-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer"
}
]
}
}
]
}
]
}
rib-table-itf-hndl_schema:
- itf-route: IPV6-RIB-EDM-ROUTE
-
Route information for a specific table/interface
- handle: integer
-
Itf Handle
Example
{
"itf-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
ipv6-rib-edm-path_schema:
- next-hop-afi: integer
-
NH afi
- has-vxlan-network-id: boolean
-
VXLAN Network Identifier exists for this path
- looped: boolean
-
Looping path
- number-of-extended-communities: integer
-
Number of extended communities
- metric: integer
-
Metrics
- ref-cnt-of-backup: integer
-
Refcnt of backup
- number-of-nnh: integer
-
Number of Next Next Hops
- ospf-area-id: string
-
OSPF area associated with the path
- span-diag-interface: string
-
SPAN Diagnostics Interface for this path
- segmented-nexthop-present: boolean
-
SegmentedNexthopPresent
- number-of-s-rv6sids: integer
-
Number of SRv6 Segment Identifiers
- binding-label: integer
-
binding Label for this path
- flags64: integer
-
Flags extended to 64 bits
- labelstk: object[]
-
Outgoing label stack for this path
- information-source: string
-
Infosource
- interface-index-present: boolean
-
Interface Index present
- remote-backup-addr: object[]
-
Remote backup node address
- vrf-import-rt-present: boolean
-
VRFIMPORTRTPresent
- next-hop-table-id: integer
-
Nexthop tableid
- backup-pathid: integer
-
Path id of this path's backup
- next-hop-vrf-name: string
-
VRF Name of the nh table
- load-metric: integer
-
Load Metrics
- xcid: integer
-
L2 Cross Connect ID for this path
- v6-information-source: string
-
V6 Infosource
- path-rt-present: boolean
-
Path RT present
- source-rd-present: boolean
-
SOURCERDPresent
- tunnel-id: integer
-
Tunnel ID associated with this path
- num-labels: integer
-
Number of labels in stack
- route-label: integer
-
Label associated with this path
- mpls-feid: integer
-
Fib mpls encap id
- srv6sid: RIB-EDM-SRV6-SID
-
List of SRv6 Segment Identifiers
- source-asrt-present: boolean
-
SOURCEASRTPresent
- next-next-hop: RIB-EDM-NNH
-
List of Next Next Hops
- private-flags: integer
-
Private Flags
- next-hop-table-name: string
-
NH table name
- next-hop-id: integer
-
NHID associated with this path
- address: string
-
Nexthop
- pathid: integer
-
Path id of this path
- nhid-feid: integer
-
Fib nhid encap id
- has-xcid: boolean
-
L2 Cross Connect ID exists for this path
- has-span-diag-interface: boolean
-
SPAN Diagnostics Interface exists for this path
- vxlan-network-id: integer
-
VXLAN Network Identifier for this path
- interface-name: string
-
Interface Name
- next-hop-id-refcount: integer
-
NHID references
- has-subscriber-parent-interface: boolean
-
Subscriber Parent Interface exists for this path
- v6-nexthop: string
-
V6 nexthop
- flags: integer
-
Flags
- interface-index-attribute: integer
-
Interface Index attribute
- next-hop-safi: integer
-
NH safi
- mvpn-present: boolean
-
MVPN attribute present
- subscriber-parent-interface: string
-
Subscriber Parent Interface for this path
- has-labelstk: boolean
-
Path has a label stack
Example
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer",
"mvpn-present": "boolean",
"subscriber-parent-interface": "string",
"has-labelstk": "boolean"
}
vrfs_schema:
VRF table
- vrf: object[]
-
Specific VRF
Example
{
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
vrf_schema:
- vrf-name: string
-
Name of the VRF
- afs: object
-
Address Family (AF) table
Example
{
"vrf-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
afs_schema:
Address Family (AF) table
- af: object[]
-
Specific AF information
Example
{
"af": [
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer"
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
af_schema:
- af-name: string
-
Name of the AF - 'IPv6'
- safs: object
-
Subsequent Address Family (SAF) table
Example
{
"af-name": "string",
"safs": {
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean"
}
]
}
}
]
}
}
]
}
}
]
}
}
safs_schema:
Subsequent Address Family (SAF) table
- saf: object[]
-
Specific SAF information
Example
{
"saf": [
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer"
}
]
}
}
]
}
}
]
}
}
]
}
saf_schema:
- saf-name: string
-
Name of the SAF
- ip-rib-route-table-names: object
-
Global container of routes
Example
{
"saf-name": "string",
"ip-rib-route-table-names": {
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer"
}
]
}
}
]
}
}
]
}
}
ip-rib-route-table-names_schema:
Global container of routes
- ip-rib-route-table-name: object[]
-
IP RIB Route table name for a topology
Example
{
"ip-rib-route-table-name": [
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string"
}
]
}
}
]
}
}
]
}
ip-rib-route-table-name_schema:
- q-routes: object
-
Quarantine
- route-table-name: string
-
Name of the route table
- protocol: object
-
Contains the classification of routes by protocol
- deleted-routes: object
-
Deleted
- backup-routes: object
-
Backup route information for the given table
- adverts: object
-
Route advertiser information
- routes: object
-
Route information
- destination-kw: object
-
Destination KW
Example
{
"q-routes": {
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
}
destination-kw_schema:
Destination KW
- dest-backup-routes: object
-
Backup
- dest-next-hop-routes: object
-
Resolving next hop
- dest-q-routes: object
-
Quarantine
- dest-best-routes: object
-
Best Local
Example
{
"dest-backup-routes": {
"dest-backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer"
}
]
}
}
]
}
}
dest-q-routes_schema:
Quarantine
- dest-q-route: IPV6-RIB-EDM-ROUTE
-
Route information of a specific Backup Address
Example
{
"dest-q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
dest-backup-routes_schema:
Backup
- dest-backup-route: IPV6-RIB-EDM-ROUTE
-
Route information of a specific Backup Address
Example
{
"dest-backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
dest-best-routes_schema:
Best Local
- dest-best-route: IPV6-RIB-EDM-ROUTE
-
Best local route information for a specific Address
Example
{
"dest-best-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
dest-next-hop-routes_schema:
Resolving next hop
- dest-next-hop-route: IPV6-RIB-EDM-ROUTE
-
Nexthop information for a specific address
Example
{
"dest-next-hop-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
adverts_schema:
Route advertiser information
- advert: IPV6-RIB-EDM-ADVERT
-
Route information of a specific Network Address
Example
{
"advert": [
{
"ipv6-rib-edm-advert": [
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
]
}
]
}
ipv6-rib-edm-advert_schema:
- code: string
-
Protocol code
- protocol-opaque: integer
-
OSPF area-id
- number-of-extended-communities: integer
-
Number of extended communities
- client-id: integer
-
Client advertising the route
- protocol-opaque-flags: integer
-
OSPF area-id flags
- protocol-id: integer
-
Protocol advertising the route
- extended-communities: string
-
Extended communities
- instance-name: string
-
Instance name
Example
{
"code": "string",
"protocol-opaque": "integer",
"number-of-extended-communities": "integer",
"client-id": "integer",
"protocol-opaque-flags": "integer",
"protocol-id": "integer",
"extended-communities": "string",
"instance-name": "string"
}
deleted-routes_schema:
Deleted
- deleted-route: IPV6-RIB-EDM-ROUTE
-
Route information for a specific deleted address
Example
{
"deleted-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
protocol_schema:
Contains the classification of routes by protocol
- subscriber: NON-AS
-
Subscriber Protocol
- isis: AS
-
ISIS Protocol
- mobile: NON-AS
-
Mobile Protocol
- ospf: AS
-
OSPF Protocol
- te-client: NON-AS
-
TEClient protocol
- bgp: AS
-
BGP Protocol
- eigrp: AS
-
EIGRP Protocol
- static: NON-AS
-
Static Protocol
- connected: NON-AS
-
Connected Protocol
- local: NON-AS
-
Local Protocol
- rpl: AS
-
RPL Protocol
Example
{
"subscriber": {
"non-as": {
"protocol-routes": {
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string"
}
]
}
}
]
}
}
}
}
protocol-routes_schema:
Protocol specific Route
- protocol-route: IPV6-RIB-EDM-ROUTE
-
Route information of a specific Network Address
Example
{
"protocol-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
routes_schema:
Route information
- route: IPV6-RIB-EDM-ROUTE
-
Route information of a specific Network Address
Example
{
"route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
q-routes_schema:
Quarantine
- q-route: IPV6-RIB-EDM-ROUTE
-
Route information for a specific quarantined address
Example
{
"q-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}
backup-routes_schema:
Backup route information for the given table
- backup-route: IPV6-RIB-EDM-ROUTE
-
Route information for a specific backup address
Example
{
"backup-route": [
{
"client-id": "integer",
"attribute-identity": "integer",
"metric": "integer",
"prefix-length-xr": "integer",
"svd-type": "integer",
"prefix": "string",
"extended-flags": "integer",
"traffic-index": "integer",
"diversion-proto-name": "string",
"diversion-distance": "integer",
"protocol-name": "string",
"priority": "integer",
"instance": "string",
"version": "integer",
"has-s-rv6-func": "boolean",
"route-precedence": "integer",
"route-label": "integer",
"route-modify-time": "integer",
"paths-count": "integer",
"qos-group": "integer",
"route-type": "integer",
"active": "boolean",
"route-version": "integer",
"route-age": "integer",
"fwd-class": "integer",
"distance": "integer",
"diversion": "boolean",
"flow-tag": "integer",
"tag": "integer",
"flags": "integer",
"route-path": {
"ipv6-rib-edm-path": [
{
"next-hop-afi": "integer",
"has-vxlan-network-id": "boolean",
"looped": "boolean",
"number-of-extended-communities": "integer",
"metric": "integer",
"ref-cnt-of-backup": "integer",
"number-of-nnh": "integer",
"ospf-area-id": "string",
"span-diag-interface": "string",
"segmented-nexthop-present": "boolean",
"number-of-s-rv6sids": "integer",
"binding-label": "integer",
"flags64": "integer",
"labelstk": [
{
"entry": "integer"
}
],
"information-source": "string",
"interface-index-present": "boolean",
"remote-backup-addr": [
{
"entry": "string"
}
],
"vrf-import-rt-present": "boolean",
"next-hop-table-id": "integer",
"backup-pathid": "integer",
"next-hop-vrf-name": "string",
"load-metric": "integer",
"xcid": "integer",
"v6-information-source": "string",
"path-rt-present": "boolean",
"source-rd-present": "boolean",
"tunnel-id": "integer",
"num-labels": "integer",
"route-label": "integer",
"mpls-feid": "integer",
"srv6sid": [
{
"sid": "string"
}
],
"source-asrt-present": "boolean",
"next-next-hop": [
{
"unknownval": "integer",
"type": "string",
"interface-index": "integer",
"address": "string"
}
],
"private-flags": "integer",
"next-hop-table-name": "string",
"next-hop-id": "integer",
"address": "string",
"pathid": "integer",
"nhid-feid": "integer",
"has-xcid": "boolean",
"has-span-diag-interface": "boolean",
"vxlan-network-id": "integer",
"interface-name": "string",
"next-hop-id-refcount": "integer",
"has-subscriber-parent-interface": "boolean",
"v6-nexthop": "string",
"flags": "integer",
"interface-index-attribute": "integer",
"next-hop-safi": "integer"
}
]
}
}
]
}